/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.hdds;

import org.apache.hadoop.ozone.Versioned;

/**
 * Base type for component version enums.
 */
public interface ComponentVersion extends Versioned {

  /**
   * Returns the description of the version enum value.
   * @return the description of the version enum value.
   */
  String description();

  /**
   * Returns the value that represents the enum in a protocol message
   * transferred over the wire.
   * @return the version associated with the enum value.
   */
  int toProtoValue();

  @Override
  default int version() {
    return toProtoValue();
  }
}
